Extension point notifications

In component org.nuxeo.ecm.platform.ec.notification.service.NotificationService

Documentation

This extension point can be used to configure available notifications. A given notification has the form:

    <notification autoSubscribed="false"
        availableIn="Section, Workspace" channel="email"
        name="Publication" template="publishContent">
        <event name="sectionContentPublished"/>
        <event name="myContentPublished"/>
    </notification>

The name

is the identifier for this notification.

The channel

is always "email".

The autoSubscribed

flag can be true if this notification is aways taken into account, or false if you want to allow users to enable/disable this notification by themselves.

The template

refers to the body template, which can be configured through the "templates" extension point.

The availableIn

attribute specifies in which types of superspaces the notification is active, it can be a comma-separated lists of types, or "*" or "all" to make the notification active in any container.

To disable an existing notification:

    <notification enabled="false" name="Publication"/>

Contribution Descriptors

Class: org.nuxeo.ecm.platform.ec.notification.service.NotificationDescriptor
Class: org.nuxeo.ecm.platform.ec.notification.service.NotificationEventDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

<extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">
    <notification availableIn="*" channel="email" label="label.document.download" name="ColdStorageContentAvailable" subject="Archive content available on '${docTitle}'" template="coldStorageContentAvailable">
      <event name="coldStorageContentAvailable"/>
    </notification>
    <notification availableIn="*" channel="email" label="label.document.download" name="ColdStorageContentRestored" subject="Main content '${docTitle}' restored" template="coldStorageContentRestored">
      <event name="coldStorageContentRestored"/>
    </notification>
  </extension>

(0) nuxeo-coldstorage-2023.2.3.jar/OSGI-INF/coldstorage-events-contrib.xml Override

<extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">
    <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" name="easyShareDownload" subject="EasyShare download notification" subjectTemplate="easyShareDownloadSubject" template="easyShareDownload">
      <event name="easyShareDownload"/>
    </notification>
    <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" name="easyShareExpired" subject="EasyShare expired notification" subjectTemplate="easyShareExpiredSubject" template="easyShareExpired">
      <event name="easyShareExpired"/>
    </notification>
  </extension>

(1) nuxeo-easyshare-core-2023.10.13.jar/OSGI-INF/extensions.xml Override

<extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">

    <notification autoSubscribed="false" availableIn="*" channel="email" enabled="true" label="notifications.name.CommentAdded" name="CommentAdded" subject="New comment on '${docTitle}'" template="commentAdded">
      <event name="commentAdded"/>
    </notification>

    <notification autoSubscribed="false" availableIn="*" channel="email" enabled="true" label="notifications.name.Modification" name="CommentUpdated" subject="Updated comment on '${docTitle}'" template="commentUpdated">
      <event name="commentUpdated"/>
    </notification>

  </extension>

(2) nuxeo-platform-comment-2023.10.13.jar/OSGI-INF/comment-notification-contrib.xml Override

<extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">

    <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="notifications.name.CommentPublication" name="CommentPublication" subject="Comment published" template="comment">
      <event name="commentPublished"/>
    </notification>

  </extension>

(3) nuxeo-platform-comment-workflow-2023.10.13.jar/OSGI-INF/notification-contrib.xml Override

<extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">

    <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.subscriptions.updated" name="Subscriptions updated" subject="New subscription" template="subscriptionsUpdated">
      <event name="subscriptionAssigned"/>
    </notification>

    <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.modif" name="Modification" subject="${docTitle} has been modified by ${author}" template="modif">
      <event name="documentModified"/>
    </notification>

    <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.create" name="Creation" subject="${docTitle} has been created by ${author}" template="modif">
      <event name="documentCreated"/>
    </notification>

    <notification autoSubscribed="true" availableIn="Section" channel="email" enabled="true" label="label.nuxeo.notifications.publication" name="Publication" subject="Document published" subjectTemplate="docPublishingSubject" template="publish">
      <event name="documentPublicationApproved"/>
      <event name="documentPublicationRejected"/>
      <event name="documentPublished"/>
    </notification>

    <notification autoSubscribed="false" availableIn="Section" channel="email" enabled="true" label="label.nuxeo.notifications.publication" name="PublicationOnClient" subject="Document published" template="publish">
      <event name="documentPublicationApproved"/>
      <event name="documentPublished"/>
    </notification>

    <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.workflow" name="Workflow Change" subject="Workflow event" template="workflow">
      <event name="workflowNewProcessStarted"/>
      <event name="workflowProcessEnded"/>
      <event name="workflowProcessCanceled"/>
      <event name="workflowAbandoned"/>
      <event name="workflowTaskCompleted"/>
      <event name="workflowTaskRejected"/>
      <event name="workflowTaskAssigned"/>
    </notification>

    <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Approbation review started" subject="Review started for ${docTitle}" template="aprobationWorkflowStarted">
      <event name="workflowNewProcessStarted"/>
    </notification>

    <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.taskAssigned" name="Task assigned" subject="Task Assigned for ${docTitle}" template="workflowTaskAssigned">
      <event name="workflowTaskAssigned"/>
    </notification>

    <notification autoSubscribed="true" availableIn="all" channel="email" enabled="true" label="label.nuxeo.notifications.email.document" name="Email document" subject="${mailSubject}" template="emailDocument">
      <event name="emailDocumentSend"/>
    </notification>

  </extension>

(4) nuxeo-platform-notification-2023.10.13.jar/OSGI-INF/notification-contrib.xml Override

<extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">

    <notification enabled="false" name="Task assigned">
      <event name="workflowTaskAssigned"/>
    </notification>
    <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Task assigned" subject="Task Assigned for ${docTitle}" template="workflowTaskAssigned" templateExpr="NotificationContext['taskInstance'].getVariable('taskNotificationTemplate')">
      <event name="workflowTaskAssigned"/>
    </notification>

   <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Task reassigned" subject="Task Reassigned on ${docTitle}" template="workflowTaskAssigned" templateExpr="NotificationContext['taskInstance'].getVariable('taskNotificationTemplate')">
      <event name="workflowTaskReassigned"/>
    </notification>

   <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Task delegated" subject="Task Delegated on ${docTitle}" template="workflowTaskDelegated">
      <event name="workflowTaskDelegated"/>
    </notification>

  </extension>

(5) nuxeo-routing-core-2023.10.13.jar/OSGI-INF/document-routing-notification-contrib.xml Override